<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>PxFoundation Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  $(document).ready(initResizable);
/* @license-end */</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="PhysXLogoBlack.png"/></td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classPxFoundation.html','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="classPxFoundation-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">PxFoundation Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span><div class="ingroups"><a class="el" href="group__foundation.html">Foundation</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>Foundation SDK singleton class.  
 <a href="classPxFoundation.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="PxFoundation_8h_source.html">PxFoundation.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aa0158936b990e4e766a6eb2947720305"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxFoundation.html#aa0158936b990e4e766a6eb2947720305">release</a> ()=0</td></tr>
<tr class="memdesc:aa0158936b990e4e766a6eb2947720305"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroys the instance it is called on.  <a href="#aa0158936b990e4e766a6eb2947720305">More...</a><br /></td></tr>
<tr class="separator:aa0158936b990e4e766a6eb2947720305"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa7c4f39a69dc0a64735af1d02c021c0f"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classPxErrorCallback.html">PxErrorCallback</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxFoundation.html#aa7c4f39a69dc0a64735af1d02c021c0f">getErrorCallback</a> ()=0</td></tr>
<tr class="separator:aa7c4f39a69dc0a64735af1d02c021c0f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aac16a599bd1ffc725f849703e7eb5696"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxFoundation.html#aac16a599bd1ffc725f849703e7eb5696">setErrorLevel</a> (<a class="el" href="structPxErrorCode.html#a01157d5d2eca2cede61ecbbc32c7b2a3">PxErrorCode::Enum</a> mask=<a class="el" href="structPxErrorCode.html#a01157d5d2eca2cede61ecbbc32c7b2a3a89d326bbd9b7d716032e07925eaaad57">PxErrorCode::eMASK_ALL</a>)=0</td></tr>
<tr class="separator:aac16a599bd1ffc725f849703e7eb5696"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae44c51d4547f4437dbcaf3db68b16bac"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="structPxErrorCode.html#a01157d5d2eca2cede61ecbbc32c7b2a3">PxErrorCode::Enum</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxFoundation.html#ae44c51d4547f4437dbcaf3db68b16bac">getErrorLevel</a> () const =0</td></tr>
<tr class="separator:ae44c51d4547f4437dbcaf3db68b16bac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8e4381d58ae863b36f53dded4bf694c9"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classPxAllocatorCallback.html">PxAllocatorCallback</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxFoundation.html#a8e4381d58ae863b36f53dded4bf694c9">getAllocatorCallback</a> ()=0</td></tr>
<tr class="separator:a8e4381d58ae863b36f53dded4bf694c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a99d8ace08bda782da561bc14c6e9075b"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxFoundation.html#a99d8ace08bda782da561bc14c6e9075b">getReportAllocationNames</a> () const =0</td></tr>
<tr class="separator:a99d8ace08bda782da561bc14c6e9075b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a10a9bd2dc04b64b17a6bb624872b565d"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxFoundation.html#a10a9bd2dc04b64b17a6bb624872b565d">setReportAllocationNames</a> (bool value)=0</td></tr>
<tr class="separator:a10a9bd2dc04b64b17a6bb624872b565d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a525b818f28e61890a574aa0c501f5991"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxFoundation.html#a525b818f28e61890a574aa0c501f5991">~PxFoundation</a> ()</td></tr>
<tr class="separator:a525b818f28e61890a574aa0c501f5991"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Foundation SDK singleton class. </p>
<p>You need to have an instance of this class to instance the higher level SDKs. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a525b818f28e61890a574aa0c501f5991"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a525b818f28e61890a574aa0c501f5991">&#9670;&nbsp;</a></span>~PxFoundation()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual PxFoundation::~PxFoundation </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a8e4381d58ae863b36f53dded4bf694c9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8e4381d58ae863b36f53dded4bf694c9">&#9670;&nbsp;</a></span>getAllocatorCallback()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="classPxAllocatorCallback.html">PxAllocatorCallback</a>&amp; PxFoundation::getAllocatorCallback </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Retrieves the allocator this object was created with. </p>

</div>
</div>
<a id="aa7c4f39a69dc0a64735af1d02c021c0f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa7c4f39a69dc0a64735af1d02c021c0f">&#9670;&nbsp;</a></span>getErrorCallback()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="classPxErrorCallback.html">PxErrorCallback</a>&amp; PxFoundation::getErrorCallback </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>retrieves error callback </p>

</div>
</div>
<a id="ae44c51d4547f4437dbcaf3db68b16bac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae44c51d4547f4437dbcaf3db68b16bac">&#9670;&nbsp;</a></span>getErrorLevel()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="structPxErrorCode.html#a01157d5d2eca2cede61ecbbc32c7b2a3">PxErrorCode::Enum</a> PxFoundation::getErrorLevel </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Retrieves mask of errors to be reported. </p>

</div>
</div>
<a id="a99d8ace08bda782da561bc14c6e9075b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a99d8ace08bda782da561bc14c6e9075b">&#9670;&nbsp;</a></span>getReportAllocationNames()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool PxFoundation::getReportAllocationNames </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Retrieves if allocation names are being passed to allocator callback. </p>

</div>
</div>
<a id="aa0158936b990e4e766a6eb2947720305"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa0158936b990e4e766a6eb2947720305">&#9670;&nbsp;</a></span>release()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void PxFoundation::release </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Destroys the instance it is called on. </p>
<p>The operation will fail, if there are still modules referencing the foundation object. Release all dependent modules prior to calling this method.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__foundation.html#ga9deda8eaad9681fc9eb456adc5225668" title="Creates an instance of the foundation class. ">PxCreateFoundation()</a> </dd></dl>

</div>
</div>
<a id="aac16a599bd1ffc725f849703e7eb5696"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aac16a599bd1ffc725f849703e7eb5696">&#9670;&nbsp;</a></span>setErrorLevel()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void PxFoundation::setErrorLevel </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structPxErrorCode.html#a01157d5d2eca2cede61ecbbc32c7b2a3">PxErrorCode::Enum</a>&#160;</td>
          <td class="paramname"><em>mask</em> = <code><a class="el" href="structPxErrorCode.html#a01157d5d2eca2cede61ecbbc32c7b2a3a89d326bbd9b7d716032e07925eaaad57">PxErrorCode::eMASK_ALL</a></code></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Sets mask of errors to report. </p>

</div>
</div>
<a id="a10a9bd2dc04b64b17a6bb624872b565d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a10a9bd2dc04b64b17a6bb624872b565d">&#9670;&nbsp;</a></span>setReportAllocationNames()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void PxFoundation::setReportAllocationNames </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>value</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Set if allocation names are being passed to allocator callback.</p>
<p>Enabled by default in debug and checked build, disabled by default in profile and release build. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="PxFoundation_8h_source.html">PxFoundation.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.14-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="classPxFoundation.html">PxFoundation</a></li>
    <li class="footer">Copyright &copy; 2008-2021 NVIDIA Corporation, 2788 San Tomas Expressway, Santa Clara, CA 95051 U.S.A. All rights reserved. <a href="http://www.nvidia.com ">www.nvidia.com</a></li>
  </ul>
</div>
</body>
</html>
